Skip to content

docs: add editor setup guide#5553

Open
davd-gzl wants to merge 5 commits intognolang:masterfrom
davd-gzl:docs/editor-setup
Open

docs: add editor setup guide#5553
davd-gzl wants to merge 5 commits intognolang:masterfrom
davd-gzl:docs/editor-setup

Conversation

@davd-gzl
Copy link
Copy Markdown
Member

@davd-gzl davd-gzl commented Apr 20, 2026

Add docs/resources/editor-setup.md covering gnopls, VS Code, and community plugins (Neovim, Vim, Emacs, Zed, Sublime Text). Update CONTRIBUTING.md to link to the new doc.

Related #5460: editor setup doc (recommended VSCode extension + workaround for LSP gap)

Add docs/resources/editor-setup.md covering gnopls, VS Code, and
community plugins (Neovim, Vim, Emacs, Zed, Sublime Text).
Update CONTRIBUTING.md to link to the new doc.

Addresses action item from gnolang#5460.

Assisted-By: OpenCode (claude-opus-4.6)
@davd-gzl davd-gzl marked this pull request as draft April 20, 2026 10:45
@github-actions github-actions Bot added 📖 documentation Improvements or additions to documentation 📄 top-level-md labels Apr 20, 2026
@Gno2D2
Copy link
Copy Markdown
Collaborator

Gno2D2 commented Apr 20, 2026

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: davd-gzl/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 User notJoon already reviewed PR 5553 with state APPROVED
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

- Add Editor Setup to docs/README.md sidebar (Resources section)
- Cross-reference from local-dev-with-gnodev.md (installation section)
- Cross-reference from power-users.md (Tools section)
- Cross-reference from configuring-gno-projects.md (gnopls note)
- Regenerate sidebar.json

Assisted-By: OpenCode (claude-opus-4.6)
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

davd-gzl and others added 3 commits April 23, 2026 11:53
- Use collapsible <details> for each editor section
- Describe gnopls as a gopls fork
- Simplify install prerequisites (link to installation page)
- Add VS Code auto-install callout
- Add Contributing section
- Tighten cross-references in CONTRIBUTING, configuring-gno-projects,
  and power-users

Assisted-By: OpenCode (claude-opus-4.7)
- Replace <details> collapsibles with plain headings (linter rejects HTML)
- Remove broken link to unmerged installation.md (describe inline)

Assisted-By: OpenCode (claude-opus-4.7)
@davd-gzl davd-gzl marked this pull request as ready for review April 23, 2026 10:06
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 23, 2026
@davd-gzl davd-gzl added the a/ux User experience, product, marketing community, developer experience team label Apr 23, 2026
Copy link
Copy Markdown
Member

@notJoon notJoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

also related to: gnoverse/gnopls#39

@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a/ux User experience, product, marketing community, developer experience team 📖 documentation Improvements or additions to documentation 📄 top-level-md

Projects

Development

Successfully merging this pull request may close these issues.

3 participants